<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SC2API: include/sc2lib/sc2_search.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="SC2-Logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SC2API
   </div>
   <div id="projectbrief">An API for AI for StarCraft II</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_807d26fa7f138cb5a03fab117dd2a7fb.html">sc2lib</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">sc2_search.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;</div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="sc2__unit_8h.html">sc2api/sc2_unit.h</a>&quot;</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="sc2__common_8h.html">sc2api/sc2_common.h</a>&quot;</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="sc2__interfaces_8h.html">sc2api/sc2_interfaces.h</a>&quot;</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacesc2.html">sc2</a> {</div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="keyword">namespace </span>search {</div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">// Clusters units within some distance of each other and returns a list of them and their center of mass.</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;std::vector&lt;std::pair&lt;Point3D, std::vector&lt;Unit&gt; &gt; &gt; Cluster(<span class="keyword">const</span> Units&amp; units, <span class="keywordtype">float</span> distance_apart);</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structsc2_1_1search_1_1_expansion_parameters.html">   16</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structsc2_1_1search_1_1_expansion_parameters.html">ExpansionParameters</a> {</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;    <span class="comment">// Some nice parameters that generally work but may require tuning for certain maps.</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;    <a class="code" href="structsc2_1_1search_1_1_expansion_parameters.html">ExpansionParameters</a>() :</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;        radiuses_({ 6.4f, 5.3f }),</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;        circle_step_size_(0.5f),</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;        cluster_distance_(15.0f),</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;        debug_(<span class="keyword">nullptr</span>) {</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;    }</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    <span class="comment">// The various radius to check at from the center of an expansion.</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;    std::vector&lt;float&gt; radiuses_;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    <span class="comment">// With what granularity to step the circumference of the circle.</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    <span class="keywordtype">float</span> circle_step_size_;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <span class="comment">// With what distance to cluster mineral/vespene in, this will be used for center of mass calulcation.</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <span class="keywordtype">float</span> cluster_distance_;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    <span class="comment">// If filled out CalculateExpansionLocations will render spheres to show what it calculated.</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <a class="code" href="classsc2_1_1_debug_interface.html">DebugInterface</a>* debug_;</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;};</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">// Calculates expansion locations, this call can take on the order of 100ms since it makes blocking queries to SC2 so call it once and cache the reults.</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;std::vector&lt;Point3D&gt; CalculateExpansionLocations(<span class="keyword">const</span> <a class="code" href="classsc2_1_1_observation_interface.html">ObservationInterface</a>* observation, <a class="code" href="classsc2_1_1_query_interface.html">QueryInterface</a>* query, <a class="code" href="structsc2_1_1search_1_1_expansion_parameters.html">ExpansionParameters</a> parameters=<a class="code" href="structsc2_1_1search_1_1_expansion_parameters.html">ExpansionParameters</a>());</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;}</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;}</div><div class="ttc" id="structsc2_1_1search_1_1_expansion_parameters_html"><div class="ttname"><a href="structsc2_1_1search_1_1_expansion_parameters.html">sc2::search::ExpansionParameters</a></div><div class="ttdef"><b>Definition:</b> sc2_search.h:16</div></div>
<div class="ttc" id="sc2__common_8h_html"><div class="ttname"><a href="sc2__common_8h.html">sc2_common.h</a></div><div class="ttdoc">Common data types, including points, rectangles and colors. </div></div>
<div class="ttc" id="sc2__unit_8h_html"><div class="ttname"><a href="sc2__unit_8h.html">sc2_unit.h</a></div><div class="ttdoc">Unit data in an observation. </div></div>
<div class="ttc" id="classsc2_1_1_query_interface_html"><div class="ttname"><a href="classsc2_1_1_query_interface.html">sc2::QueryInterface</a></div><div class="ttdef"><b>Definition:</b> sc2_interfaces.h:229</div></div>
<div class="ttc" id="namespacesc2_html"><div class="ttname"><a href="namespacesc2.html">sc2</a></div><div class="ttdef"><b>Definition:</b> sc2_action.h:9</div></div>
<div class="ttc" id="sc2__interfaces_8h_html"><div class="ttname"><a href="sc2__interfaces_8h.html">sc2_interfaces.h</a></div><div class="ttdoc">A set of public facing interfaces used to query game state. </div></div>
<div class="ttc" id="classsc2_1_1_observation_interface_html"><div class="ttname"><a href="classsc2_1_1_observation_interface.html">sc2::ObservationInterface</a></div><div class="ttdoc">The ObservationInterface reflects the current state of the game. Guaranteed to be valid when OnGameSt...</div><div class="ttdef"><b>Definition:</b> sc2_interfaces.h:47</div></div>
<div class="ttc" id="classsc2_1_1_debug_interface_html"><div class="ttname"><a href="classsc2_1_1_debug_interface.html">sc2::DebugInterface</a></div><div class="ttdef"><b>Definition:</b> sc2_interfaces.h:387</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
